docs: Document MongoDB Change Streams config and resumability#1740
Merged
Conversation
Expand the MongoDB connector docs to cover the Change Stream feature shipped in spiceai/spiceai#10813: - Document new dataset params: change_stream_batch_max_size, change_stream_batch_max_duration, change_stream_max_await_time, change_stream_batch_size, mongodb_resume_token_invalid_behavior. - Document prerequisites: primary_key=_id and on_conflict={_id: upsert} are required for delete/update routing. - Document resume token behavior (spice_sys_mongodb sidecar, at-least-once semantics, file vs in-memory restart behavior). - Document event mapping (insert, update, replace, delete, drop/rename/ invalidate truncate path). - Fix the example to use correct mongodb_* param names instead of the invalid `host:` / `db:` short forms.
✅ Pull with Spice PassedPassing checks:
|
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
1 similar comment
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
|
🚀 deployed to https://b78be85e.spiceai-org-website.pages.dev |
lukekim
approved these changes
May 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Expand the MongoDB connector docs to fully cover Change Stream support.
Source PRs
Changes
website/docs/components/data-connectors/mongodb.mdchange_stream_batch_max_size,change_stream_batch_max_duration,change_stream_max_await_time,change_stream_batch_size,mongodb_resume_token_invalid_behavior.changeStreamprivileges,primary_key: _id,on_conflict: { _id: upsert }, supported accelerators), minimal configuration, Change Stream parameter reference table, event mapping for insert/update/replace/delete/drop/rename/invalidate, and resume-token behavior across restarts (file vs in-memory accelerators, sidecar tablespice_sys_mongodb, at-least-once semantics).host:anddb:short params instead ofmongodb_hostandmongodb_db, and omitted the requiredprimary_key/on_conflictfor Change Stream operation.Test plan
cd website && npm run buildpasses locally (Docusaurus throws on broken links and undefined frontmatter tags)mongodb_resume_token_invalid_behaviorenum values against the source diff_idprimary-key/upsert requirement against runtime validation in the source PR